home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / pair333.zip / PAIR3.DOC < prev    next >
Text File  |  1992-12-25  |  21KB  |  476 lines
  1.  
  2.                              3 - PAIR POKER
  3.  
  4.                                   v3.3
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    3- PAIR Poker is a card game that requires you to accumulate 3 pairs
  21.    to win the game. You will be playing against the computer, who is a
  22.    formidable opponent. The player, if he/she wins, will accumulate points
  23.    based upon the value of the cards in their hand as well as the cards in
  24.    the computer's hand. Should the computer win then the player loses points
  25.    based upon the value of the cards in the player's hand.
  26.  
  27.  
  28.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  29.          created in the directory you run the door from.
  30.  
  31.  
  32.  
  33.                               INSTALLATION
  34.                               ____________
  35.  
  36.  
  37.    Installation is fairly easy and straight-forward. The following steps and
  38.    examples should have you up and running in a very short period of time.
  39.    It is assumed that you are familiar with setting up DOORS on your system.
  40.    To this end, only examples of the configuration file and Door batch file
  41.    are described.
  42.  
  43.       1) Create a directory to hold all PAIR3 files
  44.  
  45.       2) Unzip PAIR3xx.ZIP into the the above directory
  46.  
  47.       3) Create a configuration file, with a name of your choice, or
  48.          modify the supplied PAIR3.CFG file. A description follows:
  49.  
  50.             **                       Location of system file (See Below)
  51.             SUNRISE-80 BBS           Your BBS Name
  52.             Al                       Sysop's First name
  53.  
  54.             Lawrence                 Sysop's Last Name
  55.  
  56. |-----------------------------------------------------------------------------|
  57. | READ!     1                        CommPort  \ These 2 lines are required   |
  58. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  59. |-----------------------------------------------------------------------------|
  60.  
  61.             00000000                 Registration Number
  62.  
  63.     !   #   2                        Maximum # of Games per day
  64.                                      (Sysop gets 99 in registered verson ONLY!)
  65.  
  66.         #   0                        Max # of days a caller can make up, during
  67.                                      calls in one day. 0=Disable Make-up Option
  68.                                      Maximum value = 27, Minimum value = 1
  69.  
  70.         #   NONE                     Drive:\Path\Filename to contain the
  71.                                      Top Score Bulletin or enter NONE
  72.                                      for NO Bulletin creation.
  73.  
  74.         #   NONE                     Drive:\Path\Filename to contain the
  75.                                      Top Score Bulletin (Color) or enter NONE
  76.                                      for NO Bulletin creation.
  77.  
  78.         #   NONE                     Drive:\Path\Filename to contain the
  79.                                      Hall of Fame Bulletin or enter NONE
  80.                                      for NO Bulletin creation.
  81.  
  82.         #   NONE                     Drive:\Path\Filename to contain the
  83.                                      Hall of Fame Bulletin (Color) or enter NONE
  84.                                      for NO Bulletin creation.
  85.  
  86.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  87.                                      2 = Display ADOPT-A-DOOR message
  88.  
  89.         #   2                        Keyboard timeout value in Minutes
  90.  
  91.     !   #   0                        Time Allowed in Door
  92.                                      (Sysop = Time Remaining - REG. VERSION)
  93.  
  94.         #   N                        Automatic game reset at end of month:
  95.                                        Y = Yes enable autoreset
  96.                                        N = Keep accumulating scores
  97.  
  98.         #   Y                        Y = Allow Sysop to have 999 games
  99.                                      N = Do Not Allow Sysop 999 games
  100.  
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.  
  112.     @   #   XXXX/YYYY                 Blackout Range  From/To
  113.     @   #   XXXX/YYYY                 Blackout Range  From/To
  114.     @   #   XXXX/YYYY                 Blackout Range  From/To
  115.     @   #   XXXX/YYYY                 Blackout Range  From/To
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.  
  118.           ** = Replace with ONE of the following:
  119.  
  120. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  121. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  122. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  123.                                    (Note:DOOR.SYS must be in SAME directory)
  124. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  125. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  126. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  127. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  128. C:\BBS\CHAIN.TXT                <- For WWIV systems
  129. C:\BBS\GTUSER.BBS               <- For GT Power
  130.                                    * if using this option you must put the
  131.                                      ComPort # on line 5 and the Node # on
  132.                                      line 6 of the configuration file
  133.  
  134.  
  135.  
  136.            # = Requires registration to change to a different value.
  137.            ! = See "Plays per DAY/DOOR Time" Below
  138.            @ = See "Blackout Periods" Below
  139.  
  140.  
  141.                NOTE: There are NO Blank Lines in the Config File!!
  142.  
  143.  
  144.       4) Create a batch file or modify the PAIR3 file supplied. A
  145.          description of this file follows:
  146.  
  147.             ECHO off
  148.             cd\PCB\DOORS\PAIR3        Location of Piar3 files
  149.             PAIR3 PAIR3.CFG           EXE filename and CNF filename (Name
  150.                                       used in creating file in #3 above)
  151.             CD\PCB
  152.             BOARD
  153.  
  154.  
  155.        5) When running in more than one node, be sure to supply a
  156.           different configuration name for each node (your choice of name).
  157.  
  158.        6) If running with Fossil-based multi-port boards add
  159.            /FD to the line containing the CFG name as follows:
  160.  
  161.                           PAIR3 PAIR3.CFG /FD
  162.  
  163.  
  164.  
  165.  
  166.  
  167.                MAKE-UP DAYS (Registered version only)
  168.                --------------------------------------
  169.  
  170. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  171. during the current month and prior to the current call. You control whether
  172. to allow this option, as well as the number of days the caller can make up, on
  173. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  174. configuration file, turns the option OFF, any other value (up to a max of 27)
  175. turns the option ON and dictates the number of days the caller can make up.
  176.  
  177.  
  178. NOTE:      The number of games per day is calculated as follows...
  179.  
  180.            Games Allowed per day x Number of makeup days.
  181.  
  182. Example:   Games Allowed per day = 2
  183.            Max # of makeup days  = 4
  184.  
  185. If a caller logs in on 5/8/92 and this is their first call of the month, they
  186. would have a potential of 16 games to makeup and bring them current
  187. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  188. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  189. (games allowed * max # of makeup days).
  190.  
  191.  
  192.  
  193.              HALL OF FAME BULLETINS (Registered version only)
  194.              ------------------------------------------------
  195.  
  196. The program will automatically reset the game when the first caller of the
  197. month plays the game. The score file will be cleared and a set of Hall of Fame
  198. bulletin files will be created. The files will be called SUNHOF.ASC and
  199. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  200. directory as the PAIR3.EXE file. You are responsible for COPYING the files to
  201. your bulletin area and renaming to a filename of your choice.
  202.  
  203. WARNING: The HOF files are cumulative files. That means they are read in each
  204.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  205.          the record of prior months winners!!!!
  206.  
  207.  
  208.  
  209.  
  210.                           BLACKOUT PERIODS
  211.                           ________________
  212.  
  213.       Use the Blackout ranges option to define up to 5 time periods during
  214.       which you DO NOT want the Door to be played. If a caller tries to access
  215.       the Door during the Blackout period, they will be shown a message that
  216.       contains ALL the Blackout periods you have defined, and to try the Door
  217.       at a later time.
  218.  
  219.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  220.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  221.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  222.  
  223.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  224.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  225.                    a Blackout range.
  226.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  227.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  228.  
  229.  
  230.  
  231.                           PLAYS Per DAY/DOOR Time
  232.                           _______________________
  233.  
  234.       Plays Per Day and Door Time can be controlled several ways:
  235.  
  236.       (1) You can use the Games Per Day, singular option, in the config
  237.           file above. This option, will affect ALL callers whose Security
  238.           Level is NOT defined in any of the 10 optional Security Level/
  239.           Plays Per Day entries in the config file.
  240.  
  241.       (2) You can use the Door Time, singular option, in the config file
  242.           above. This option, will affect ALL callers whose Security
  243.           Level is NOT defined in any of the 10 optional Security Level/
  244.           Plays Per Day/Door Time entries in the config file.
  245.  
  246.       (3) You can restrict the number of games a specific Security Level
  247.           will be allowed to play per day or REWARD specific Levels with
  248.           more Plays Per Day.
  249.  
  250.           Likewise, you can restrict the Play time for a specific Security
  251.           Level or REWARD specific Levels with more Door Time.
  252.  
  253.           These options are handled by the use of the 10 config
  254.           entries (000=00/00).
  255.  
  256.           The format of each entry is as follows:
  257.  
  258.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  259.                      where =  is a constant and MUST be included
  260.                      where YY is the # of games per day (must be 2 digits)
  261.                      where / is a constant and MUST be included
  262.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  263.  
  264.           If the callers Security Level is NOT defined, his/her Plays Per
  265.           Day and Door Time will be controlled by the values in items
  266.           (1) and (2), above, respectively..
  267.  
  268.           You may define up to 10 Security Levels. All unused entries must
  269.           be defined as   000=00/00
  270.         --------------------------------------------------------------------
  271.           Example: Suppose you had 3 Security Levels defined on your BBS as
  272.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  273.           wanted to set Plays Per Day as :     Subscriber=5
  274.                                            Visiting Sysop=2
  275.                                                   CoSysop=3
  276.                                                    Friend=10
  277.  
  278.           and Door Time as follows:     Subscriber=30 minutes
  279.                                     Visiting Sysop=20 minutes
  280.                                            CoSysop=10 minutes
  281.                                             Friend=remaining call time
  282.  
  283.  
  284.           You would set the Individual "Games per Day" config entry to 1 and
  285.           the individual "Door Time" to 5 minutes (these would be the
  286.           default number of games and default Time for all Security Levels
  287.           other than 20,30 or 40... make them any number you want). Next you
  288.           would replace 4 of the Security Level entries as :  020=05/30
  289.                                                               030=02/20
  290.                                                               040=03/10
  291.                                                               090=10/0
  292.  
  293.  
  294.  
  295.                         NON-STANDARD COM SUPPORT
  296.                         ________________________
  297.  
  298.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  299.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  300.       number after the configuration filename. Let's assume your Door is
  301.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  302.       passed to your Door would be:
  303.  
  304.                             FOOBAR FOOBAR.CFG /5
  305.  
  306.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  307.       normally used with COM1. No /x parameter is needed for the standard
  308.       IRQ's.
  309.  
  310.       As an alternative, you may use an environmental variable on the command
  311.       line. To use the variable (following the example above), place a
  312.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  313.       different IRQ number for each node). The command line would now look
  314.       like this:
  315.  
  316.                           FOOBAR FOOBAR.CFG /%IRQ%
  317.  
  318.       This, in combination with the use of the environmental variables
  319.       described in the MULTI-NODE SETUP section will allow you to use one
  320.       batch file and one config file to run this door on all nodes.
  321.  
  322.  
  323.  
  324.  
  325.                            MULTI-NODE SETUP
  326.                            ________________
  327.  
  328.       All Sunrise Doors are Multi-Node capable. Each node must have the
  329.       ability to access a configuration file which will have its own system
  330.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  331.       line. There are 2 ways to accomplish this:
  332.  
  333.       (1) Create a separate configuration file for each node. The only
  334.           difference between each file would be the location of the system
  335.           file for that particular node. For example, on my system there are 2
  336.           nodes and the first line of the config files would look like this:
  337.  
  338.                         NODE1:  H:\PCB1\DOOR.SYS
  339.                         NODE2:  H:\PCB2\DOOR.SYS
  340.  
  341.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  342.  
  343.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  344.           the following PCBoard environmental variables:
  345.  
  346.                  PCBDIR    (Directory containing the System file)
  347.                  PCBDRIVE  (Drive containing the System file)
  348.  
  349.           Thus, the first line of the SINGLE configuration file, for this Door
  350.           would look like this:
  351.  
  352.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  353.  
  354.       NOTE: This option, as described, assumes that you are running PCBoard
  355.             14.5a software. The environmental variables are automatically
  356.             created by the software for each node.
  357.  
  358.             HOWEVER, if you are running other BBS software you should be able
  359.             to set the variables EXACTLY as described below, for EACH node
  360.             (more than likely in each batch file you use to bring up EACH node):
  361.  
  362.                             PCBDRIVE=C:
  363.                             ^^^^^^^^^
  364.                             PCBDIR=\NODE2
  365.                             ^^^^^^^^
  366.  
  367.             Info with a carat (^) under it, MUST be typed as is. The rest
  368.             depends on your naming conventions.
  369.  
  370.             This, in combination with the use of the optional environmental
  371.             variable described in the NON-STANDARD COM SUPPORT section, will
  372.             allow you to use one batch file and one config file to run this
  373.             door on all nodes.
  374.  
  375.  
  376.  
  377.  
  378.                                ADOPT-A-DOOR
  379.                                ____________
  380.  
  381.     Having been a Sysop for a number of years, I have had my share of problems
  382.     and frustrations getting financial support for my board's upkeep. A fellow
  383.     Sysop left a message on my board, not long ago, about a concept that was
  384.     being used by several boards around the country.
  385.  
  386.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  387.     would be the same as sending in a donation, only this way it is earmarked
  388.     for registering a particular door. In a way, the user feels he/she is
  389.     "getting something in return". As a Door author I have decided to build
  390.     this concept into each of my Door programs. The concept replaces the
  391.     usual message "tell the Sysop to register this Door" we find in most
  392.     doors.
  393.  
  394.     If the Door is unregisterd then a message appears on the opening screen
  395.     to that effect. After finishing or suspending a game, a message screen
  396.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  397.     caller to contact the Sysop to find out if there is any further details
  398.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  399.     time, etc to callers that ADOPT-A-DOOR.
  400.  
  401.     If the Door has been registered, either by the Sysop or other callers,
  402.     the names of those contributors will be displayed in the closing screen.
  403.  
  404.     NOTE: If you want to display the names of the callers that contributed
  405.           to registering the Door, you must create an ASCII file called
  406.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  407.           the name(s) of the contributors (one on each line, maximum of 5
  408.           entries, each a maximum of 30 characters long). This file must be
  409.           saved, in ASCII format, and placed in the Door directory.
  410.  
  411.  
  412.  
  413.                               LEGALITIES
  414.                               __________
  415.  
  416.  
  417.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  418.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  419.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  420.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  421.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  422.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  423.       OR BREACH OF ANY WARRANTY.
  424.  
  425.  
  426.  
  427.  
  428.  
  429.                              DISTRIBUTION
  430.                              ____________
  431.  
  432.    You may make this file available for downloading from your BBS or you may
  433.    upload it to any BBS of your choice, provided that you do not make any
  434.    changes to the contents of the archive (ZIP file). The archive and its
  435.    individual contents may not be used by any service that charges any money
  436.    whatsoever, without the written permission of the author.
  437.  
  438.  
  439.  
  440.  
  441.  
  442.                              REGISTRATION
  443.                              ____________
  444.  
  445.    Registration and the subsequent insertion of the registration number into
  446.    your configuation file, allows for the display of your BBS name on the
  447.    opening and closing screen as well as the reduction of a delay built into
  448.    the opening screen display along with the ability to change certain
  449.    values in the configuration file.
  450.  
  451.    To register your copy of 3-PAIR, please fill out the registration form
  452.    (REGISTER.FRM) and mail it along with the registration fee to
  453.    the name and address on the form.
  454.  
  455.    Be sure to use the proper upper/lower case when filling in your name and
  456.    BBS name, as they MUST match the way you entered them in the configuration
  457.    file.             ^^^^
  458.  
  459.    Based upon information supplied on the registration form, I will pre-
  460.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  461.    up your registration number.
  462.  
  463.  
  464.  
  465.                                  MISC
  466.                                  ____
  467.  
  468.    The latest version of 3-PAIR DICE and other fine SUNRISE DOOR programs
  469.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  470.  
  471.    Remember, should you have any problems, questions or suggestions, be sure
  472.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  473.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  474.  
  475.  
  476.